-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Add docs for 'astro db' CLI commands to reference/cli-reference, incl… #12965
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for 'astro db' CLI commands to reference/cli-reference, incl… #12965
Conversation
…uding proposed --db-app-token flag on separate PR
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
Hello! Thank you for opening your first PR to Astro’s Docs! 🎉 Here’s what will happen next:
|
|
@withastro/maintainers-docs |
|
Hi, thanks for creating a docs PR to accompany your core PR!
The CLI reference only documents commands available without any additional packages. Astro DB requires Can you revert the changes to |
@ArmandPhilippot done. I noticed looking at those docs that the I also alphabetized the available flags - the ordering was inconsistent previously between the different commands (some in most-important-flag order, others in alphabetical). |
|
(Noting that I don't see any response to the astro PR for this feature, and so normally we wait until we see some kind of indication there that this feature will be accepted, and in its current form, before looking at the docs. Things can change over the course of a feature PR, so we wait for a sign that usage/documentation is not likely to change (even if implementation does) before editing docs PRs too carefully. I have pinged the devs to let them know we have a docs PR that is just sitting here in this state, so hopefully someone will respond to the implementation PR soon!) |
sarah11918
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this contribution @webstackdev ! Just a couple of quick comments -- one to use our template for introducing code examples, and the other is a paragraph not related to the new content added that seems to be rewritten, so I just want some other maintainers to check on it! 🚀
|
Leaving a note for @ArmandPhilippot - normally we'd have a |
|
With the current format, I don't see how this could be integrated. One option would be to change the format and create a heading for each flag, something like our CLI reference... but this is out of scope of this PR. |
Princesseuh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I can tell, the content of this PR is confirmed factual by my human eyes
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
|
Code is all looking good, thank you everyone! Just waiting for Netlify so I can review the deploy preview for anything that might be visible there! |
sarah11918
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Preview looks good to me! Thanks for your patience @webstackdev , and welcome to Team Docs! 🥳
Description (required)
Add docs for 'astro db' CLI commands to
reference/cli-reference. I have a PR opened on the astro code repo to add a--db-app-tokenflag to theastro dbexecute,push, andverifycommands. I'll update this PR with that number. I noticed that there was no documentation in thecli-referencedocument for any of thedbCLI commands so I scaffolded them with relevant flags described.Related issues & labels
For Astro version:
5.x. See astro PR 15069.